home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / qprn102.zip / ADDON.DOC < prev    next >
Text File  |  1993-04-25  |  9KB  |  170 lines
  1.   This file describes some add-on programs and files for QWKPRUNE.
  2.  
  3.  
  4.                          $$1300.CMD and UNKILL.CMD
  5.                                    -----
  6.   $$1300.CMD and UNKILL.CMD are sample 1stReader .CMD files for use with
  7.   QWKPRUNE.  To install them, simply copy both files to the directory
  8.   1stReader is in.  If you already have a $$1300.CMD or $$13.CMD file,
  9.   rename $$1300.CMD to KILL.CMD before copying it to the 1stReader
  10.   directory, and add "Kill messages,FILE=KILL.CMD" to your $$1300.CMD or
  11.   $$13,CMD file.
  12.  
  13.   Once the files are installed, you can call up $$1300.CMD by pressing F7
  14.   while a message is on the screen.  If a message is not on the screen,
  15.   $$1300.CMD will not come up when F7 is pressed.
  16.  
  17.   $$1300.CMD and UNKILL.CMD contain entries for KILLMSG and ZIPPYZAP.
  18.  
  19.  
  20.                                 KILLMSG 1.02
  21.                                    -----
  22.   KILLMSG is a program to allow users of 1stReader to tag messages to be
  23.   deleted by QWKPRUNE.  Users may also untag messages and check if the
  24.   messages on the screen is tagged.
  25.  
  26.   To install it, copy KILLMSG.EXE to the directory where 1stReader is
  27.   located.  You'll also need to install $$1300.CMD and UNKILL.CMD.
  28.  
  29.   The entry in $$1300.CMD labeled "Current Message" calls KILLMSG to tag
  30.   the current message to be deleted.  UNKILL.CMD also has an entry labeled
  31.   "Current Message", which calls KILLMSG to untag the current message.
  32.  
  33.   KILL.DOS, UNKILL.DOS, and CHECK.DOS are 1stReader .DOS files that contain
  34.   commands to have KILLMSG tag, untag, and check messages, respectively.
  35.   They can be used with KILLM.BAT to assign these functions to function
  36.   keys.  For example, if you want pressing Shift-F1 to kill the message on
  37.   the screen, copy KILL.DOS and KILLM.BAT to the directory 1stReader is in
  38.   and rename them $$F1.DOS and $$F1.BAT.  If you also want pressing
  39.   Shift-F2 to unkill the current message, make a separate copy of KILLM.BAT
  40.   named $$F2.BAT, and copy UNKILL.DOS to the 1stReader directory and rename
  41.   it $$F2.DOS.
  42.  
  43.   If no message is on the screen, or if you are in the Folders or Replies
  44.   conference, KILLMSG will exit.
  45.  
  46.   Note: KILLMSG checks for the existence of a file in the work directory
  47.   named MESSAGES.BAK.  If it doesn't exist, MESSAGES.DAT will be copied to
  48.   MESSAGES.BAK.  All work will be done on MESSAGES.BAK.  This is necessary
  49.   because 1stReader 1.01 has a habit of resetting the message-deleted flag
  50.   in each message header to its original value.  If you're using
  51.   1stReader's bookmark switch to repack the QWK, rename MESSAGES.BAK to
  52.   MESSAGES.DAT just before quitting the packet.  1stReader inserts the
  53.   bookmark before running $$EXIT.BAT.
  54.  
  55.  
  56.                                ZIPPYZAP 1.01
  57.                                    -----
  58.   ZIPPYZAP allows users of Deluxe², 1stReader, and Session Manager to tag
  59.   all messages found by those readers' Zippy text search for deletion by
  60.   QWKPRUNE.  It can also untag these messages.  Install it by copying
  61.   ZIPPYZAP.EXE to the directory where your reader is located, or to a
  62.   directory in your DOS path.
  63.   
  64.   The command line format is:
  65.     ZIPPYZAP switch work_dir [reader]
  66.  
  67.   Switch is either a K or a U, and specifies whether messages are to be
  68.   killed (K) or unkilled (U).  Work_dir is the work directory defined in
  69.   the reader's configuration.  Reader is either /1 for 1stReader or
  70.   /S for Session Manager.  If /1 is used, ZIPPYZAP will create and use
  71.   MESSAGES.BAK, as described for KILLMSG.  The sample menus for Deluxe²
  72.   and 1stReader have entries for ZIPPYZAP.   A macro such as
  73.   <CtrlJ><CtrlO> zippyzap K [work_dir] /S<Enter> should work in Session
  74.   Manager.  Replace [work_dir] with the work directory defined in Session
  75.   Manager's configuration.  Session Manager won't show if a message is
  76.   tagged for deletion, and I know of no way to get that information from
  77.   within it.  If anyone does know of a way, please let me know.
  78.  
  79.   ZIPPYZAP has only been tested with Deluxe², 1stReader, and Session
  80.   Manager.  If other readers have a Zippy text search, it may (or may not)
  81.   work with them.
  82.  
  83.   ZIPPYZAP can be also used with 1stScan.  This will allow you to prune out
  84.   messages based on their text.  If you want to leave the messages tagged,
  85.   and aren't using 1stReader, delete the ZIPPY.NDX file created by 1stScan
  86.   after ZIPPYZAP is finished.  When it runs, QWKPRUNE will delete this
  87.   file.
  88.  
  89.   Messages tagged by KILLMSG and ZIPPYZAP can be unkilled by entries in a
  90.   prune file.  To be sure that all tagged messages are deleted, use
  91.   QWKPRUNE's /N switch.
  92.  
  93.  
  94.                                 SAVEQWK 1.01
  95.                                    -----
  96.   SAVEQWK allows users of 1stReader to repack the current QWK packet,
  97.   saving any changes that have been made.  Install it by copying
  98.   SAVEQWK.EXE and SAVEQWK.FIL to the directory where 1stReader is located.
  99.   SAVEQWK takes no command line arguments.  If you're using 1stReader's
  100.   internal zipper, PKZIP must be in the current directory or on your DOS
  101.   path.
  102.  
  103.   SAVEQWK will detect the MESSAGES.BAK file used by KILLMSG and ZIPPYZAP,
  104.   and rename it MESSAGES.DAT before calling the packer.  Since MESSAGES.BAK
  105.   will no longer exist, you should do this just before quitting the packet.
  106.  
  107.   In fact, adding "/CLS /IN:SAVEQWK.FIL /OUT:SAVEQWK.$$$" (without quotes)
  108.   to your $$EXIT.DOS file will let you run SAVEQWK from $$EXIT.BAT.  If you
  109.   want, use "if exist %2messages.bak" (again w/o quotes) to check for the
  110.   existence of MESSAGES.BAK.
  111.  
  112.   N.B.  If you're using the March 14, 1993 release of 1stReader, or any
  113.   later release, change the first line of SAVEQWK.FIL to @API$(136).
  114.  
  115.                                  MKPRN 1.01
  116.                                    -----
  117.   MKPRN is a utility to add a line to a prune file from within a mail
  118.   reader.  Install it by copying it to the directory where your reader is
  119.   located, or to a directory in your DOS path.
  120.  
  121.   Your reader should have configurable function keys or user-definable
  122.   menus.  It should also have substitution variables which can be used in
  123.   function key definitions or menu entries.  It needs to have variables
  124.   for the BBSID of the board the packet is from, the contents of the From:
  125.   and To: fields, and the subject line.  It helps if there's a variable for
  126.   the conference number the message is in, but this can be omitted.  Check
  127.   the manual for your reader to see if it has substitution variables and
  128.   what they are.  Of course, it may also be run from the DOS command line.
  129.  
  130.   The command line format is:
  131.     MKPRN filename  "switch:text"  conference number
  132.  
  133.   Switch must be a valid prune file switch, such as T, F, B, S, or N.  See
  134.   QWKPRUNE.DOC for details.  Text is the text to search for, and should be
  135.   represented by one of your reader's substitution variables. The whole
  136.   combination must be enclosed in double quotes so that it will be treated
  137.   as a single argument, regardless of how may spaces may be in the text.
  138.  
  139.   Filename is the name of the file to write to.  If your reader has a
  140.   substitution variable for the BBSID of the board the packet is from, use
  141.   it.  It's best if you specify the directory where the file should go.
  142.  
  143.   Conference number is the number of the conference the message is in.
  144.   If your reader doesn't have a substitution variable for this, you can
  145.   omit it, and use your editor to enter the conference number.  You can
  146.   also use A (for all conferences).   Place an exclamation point in front
  147.   of this to generate an "unkill" line.
  148.  
  149.   If the text to search for contains double quote marks, it'll be parsed
  150.   into multiple arguments.  In such cases, MKPRN will exit without writing
  151.   to file.  Text like this can be added to the file with the DOS echo
  152.   command and output redirection.
  153.  
  154.                                 GRABNUM 1.00
  155.                                    -----
  156.   GRABNUM gets the message number and conference number from DeLuxe²'s
  157.   message export file, and writes them to a prune file.  Install it by
  158.   copying it to the directory where DeLuxe² is located.
  159.  
  160.   The command line format is:
  161.     GRABNUM switch export_filename prune_filename
  162.  
  163.   Switch is either a K or a U, and specifies whether messages are to be
  164.   killed (K) or unkilled (U).  Export_filename is the "Message export
  165.   filespec" defined in DeLuxe²'s configuration.  Prune_filename is the file
  166.   to write to.
  167.  
  168.   Grabnum will also read the message export files created by 1stReader's
  169.   /EXPORT: <filespec> DOS shell modifier.
  170.